Embed API Object Overview

The following are the main objects in the Embed API library.

PyramidEmbedClient - This is the main client object. This object manages the life-cycle of the embedded elements on a host page.

• Embed - this is the central method in the API used to embed content directly into a host page. It returns a Content object which has is own methods. The following objects are used in conjunction with this method to tailor the way the content object works.
  • EmbedOptions- This object represents the embed request selections that are submitted when initializing an content object
    • QuickEmbedOptions- This object extends EmbedOptions, offering a simplified mechanism to initialize content objects.
    • ExportTypes - This object represents which export types are available to users in the UI.
    • Filter - This object represents one or more filters that can be attached to embedded content requests
    • Target - This object represents one or more targets that can be attached to embedded 'Present' content requests
    • AppStyles - This object contains detailed properties for adjusting the embedded client application's appearance.
    • CustomTheme - This object contains details on how to customize the content theme styling used for analytic visualizations.

   

• Hub - this is the central method in the API used to embed the hub directly into a host page. It returns a Hub object which has is own methods. The following objects are used in conjunction with this method to tailor the way the hub object works.
  • HubEmbedOptions- This object represents the embed request selections that are submitted when initializing an hub object
  • Style - This object represents one or more filters that can be attached to embedded content requests
  • AppStyles - This object contains detailed properties for adjusting the embedded client application's appearance within an embedded Hub.

   

• Search - this is the central method in the API used to embed search directly into a host page. It returns a Search object which has is own methods. The following objects are used in conjunction with this method to tailor the way the search object works.
  • SearchEmbedOptions- This object represents the embed request selections that are submitted when initializing an search object

    • AppStyles - This object contains detailed properties for adjusting the embedded search's appearance.

    • CustomTheme - This object contains details on how to customize the content theme styling used for analytic visualizations.